<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Compass Path
    |--------------------------------------------------------------------------
    |
    | This is the URI path where Compass will be accessible from. Feel free
    | to change this path to anything you like.
    |
    */

    'path' => env('COMPASS_PATH', 'compass'),

    /*
    |--------------------------------------------------------------------------
    | Laravel Routes
    |--------------------------------------------------------------------------
    |
    | This is the routes rules that will be filtered for the requests list.
    | use "*" as a wildcard to match any characters. note that the following
    | array list "exclude" can be referenced by the route name or route URI.
    | "base_uri" is a string value as a comparison for grouping the routes.
    |
    */

    'routes' => [
        'domains' => [
            '*',
        ],

        'prefixes' => [
            '*',
        ],

        'exclude' => [
            'compass.*',
            'debugbar.*',
            '_ignition/*',
            'telescope/*',
            'sanctum/*',
            'captcha/*',
            ''
        ],

        'base_uri' => 'api/',
    ],

    /*
    |--------------------------------------------------------------------------
    | Compass Storage Driver
    |--------------------------------------------------------------------------
    |
    | This configuration options determines the storage driver that will
    | be used to store your API calls and routes. In addition, you may set any
    | custom options as needed by the particular driver you choose.
    |
    */

    'driver' => env('COMPASS_DRIVER', 'database'),

    'storage' => [
        'database' => [
            'connection' => env('DB_CONNECTION', 'mysql'),
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Compass Authenticator
    |--------------------------------------------------------------------------
    |
    | This options allow you to get all the "credentials" of users that you can
    | use to perform auth requests through the UI. when "enabled" set to "true"
    | you should adjust the authentication guard driver for your application to
    | support "token" or "sanctum".
    |
    */

    'authenticator' => [
        'enabled' => false,
        'guard' => 'api',
        'identifier' => 'email',
    ],

    /*
    |--------------------------------------------------------------------------
    | Compass Documenter Provider
    |--------------------------------------------------------------------------
    |
    | This configuration option determines the documenter provider that will be
    | used to create a beautiful API documentation. In addition, you may set
    | any custom options as needed by the particular provider you choose.
    |
    */

    'documenter' => 'documentarian',

    'provider' => [
        'documentarian' => [
            'output' => 'public/docs',
            'example_requests' => [
                'bash',
            ],
        ],
    ],
];
